home *** CD-ROM | disk | FTP | other *** search
/ Meeting Pearls 1 / Meeting Pearls Vol 1 (1994).iso / installed_progs / comm / ums / developer.lha / Developer / interfaces / c / include / libraries / ums.h
Encoding:
C/C++ Source or Header  |  1993-11-15  |  13.1 KB  |  306 lines

  1. #ifndef LIBRARIES_UMS_H
  2. #define LIBRARIES_UMS_H
  3.  
  4. /*
  5.  * libraries/ums.h
  6.  *
  7.  * C definitions for ums.library
  8.  *
  9.  * $VER: ums.h 10.2 (15.11.93)
  10.  *
  11.  */
  12.  
  13. #ifndef EXEC_TYPES_H
  14. #include <exec/types.h>
  15. #endif
  16.  
  17. #ifndef UTILITY_TAGITEM_H
  18. #include <utility/tagitem.h>
  19. #endif
  20.  
  21. #define UMSNAME    "ums.library"
  22. #define UMSVERSION 10
  23.  
  24. /* typedefs */
  25. typedef void     *UMSUserAccount; /* UMS user account   */
  26. typedef LONG      UMSMsgNum;      /* UMS message number */
  27. typedef WORD      UMSError;       /* UMS error number   */
  28. typedef LONGBITS  UMSSet;         /* UMS bit set        */
  29.  
  30. #define UMSMAXMSGS 2147483647  /* LONG --> 2^31-1    */
  31.  
  32. /* message array index definitions (see UMS Doc #3) */
  33. #define UMSCODE_MsgText       0
  34. #define UMSCODE_FromName      1
  35. #define UMSCODE_FromAddr      2
  36. #define UMSCODE_ToName        3
  37. #define UMSCODE_ToAddr        4
  38. #define UMSCODE_MsgID         5
  39. #define UMSCODE_CreationDate  6
  40. #define UMSCODE_ReceiveDate   7
  41. #define UMSCODE_ReferID       8
  42. #define UMSCODE_Group         9
  43. #define UMSCODE_Subject      10
  44. #define UMSCODE_Attributes   11
  45. #define UMSCODE_Comments     12
  46. #define UMSCODE_Organization 13
  47. #define UMSCODE_Distribution 14
  48. #define UMSCODE_Folder       15
  49. #define UMSCODE_FidoID       16
  50. #define UMSCODE_MausID       17
  51. #define UMSCODE_ReplyGroup   18
  52. #define UMSCODE_ReplyName    19
  53. #define UMSCODE_ReplyAddr    20
  54. #define UMSCODE_FidoText     32
  55. #define UMSCODE_ErrorText    33
  56. #define UMSCODE_Newsreader   34
  57. #define UMSNUMFIELDS         128
  58.  
  59. /* message data types */
  60. typedef char *UMSMsgTextFields[UMSNUMFIELDS];
  61. struct MessageInfo {
  62.                     LONG      msgi_HeaderLength;
  63.                     LONG      msgi_TextLength;
  64.                     LONG      msgi_Date;
  65.                     UMSMsgNum msgi_ChainUp;
  66.                     UMSMsgNum msgi_ChainDn;
  67.                     UMSMsgNum msgi_ChainLt;
  68.                     UMSMsgNum msgi_ChainRt;
  69.                     UMSSet    msgi_GlobalStatus;
  70.                     UMSSet    msgi_UserStatus;
  71.                     UMSSet    msgi_LoginStatus;
  72.                     UMSMsgNum msgi_HardLink;
  73.                     UMSMsgNum msgi_SoftLink;
  74.                    };
  75.  
  76. /* user status bits */
  77. #define UMSUSTATB_Archive      4
  78. #define UMSUSTATF_Archive     (1L<<4)
  79. #define UMSUSTATB_Junk         5
  80. #define UMSUSTATF_Junk        (1L<<5)
  81. #define UMSUSTATB_PostPoned    6
  82. #define UMSUSTATF_PostPoned   (1L<<6)
  83. #define UMSUSTATB_Selected     7
  84. #define UMSUSTATF_Selected    (1L<<7)
  85. #define UMSUSTATB_Filtered     15
  86. #define UMSUSTATF_Filtered    (1L<<15)
  87.  
  88. #define UMSUSTATB_Old          8
  89. #define UMSUSTATF_Old         (1L<<8)
  90. #define UMSUSTATB_Read        UMSUSTATB_Old
  91. #define UMSUSTATF_Read        UMSUSTATF_Old
  92. #define UMSUSTATB_WriteAccess  9
  93. #define UMSUSTATF_WriteAccess (1L<<9)
  94. #define UMSUSTATB_ReadAccess  10
  95. #define UMSUSTATF_ReadAccess  (1L<<10)
  96. #define UMSUSTATB_ViewAccess  11
  97. #define UMSUSTATF_ViewAccess  (1L<<11)
  98. #define UMSUSTATB_Owner       12
  99. #define UMSUSTATF_Owner       (1L<<12)
  100.  
  101. #define UMSUSTATF_Protected   (UMSUSTATF_WriteAccess | UMSUSTATF_ReadAccess | UMSUSTATF_ViewAccess | UMSUSTATF_Owner)
  102.  
  103. /* global status bits */
  104. #define UMSGSTATB_Deleted      0
  105. #define UMSGSTATF_Deleted     (1L<<0)
  106. #define UMSGSTATB_Expired      1
  107. #define UMSGSTATF_Expired     (1L<<1)
  108. #define UMSGSTATB_Exported     2
  109. #define UMSGSTATF_Exported    (1L<<2)
  110. #define UMSGSTATB_Orphan       3
  111. #define UMSGSTATF_Orphan      (1L<<3)
  112. #define UMSGSTATB_Link         4
  113. #define UMSGSTATF_Link        (1L<<4)
  114. #define UMSGSTATB_HardLink     5
  115. #define UMSGSTATF_HardLink    (1L<<5)
  116.  
  117. #define UMSGSTATF_Protected   (UMSGSTATF_Deleted | UMSGSTATF_Exported | UMSGSTATF_Orphan | UMSGSTATF_Link | UMSGSTATF_HardLink)
  118.  
  119. /* UMS error numbers */
  120. #define UMSERR_OK                  0
  121. #define UMSERR_Unknown             1
  122.  
  123. #define UMSERR_CodeMissing       100
  124. #define UMSERR_ForbiddenCode     101
  125. #define UMSERR_NoWriteAccess     102
  126. #define UMSERR_NoReader          103
  127. #define UMSERR_NoExporter        104
  128. #define UMSERR_BadLink           105
  129. #define UMSERR_NoWork            106
  130. #define UMSERR_NoSysop           107
  131. #define UMSERR_BadChange         108
  132.  
  133. #define UMSERR_Dupe              200
  134. #define UMSERR_NoReadAccess      201
  135. #define UMSERR_NoViewAccess      202
  136. #define UMSERR_MsgCorrupted      203
  137. #define UMSERR_NoHdrSpace        204
  138. #define UMSERR_NoSuchMsg         205
  139. #define UMSERR_BadName           206
  140. #define UMSERR_BadTag            207
  141. #define UMSERR_MissingTag        208
  142. #define UMSERR_NoSuchUser        209
  143. #define UMSERR_NotFound          210
  144. #define UMSERR_AutoBounce        211
  145. #define UMSERR_MsgDeleted        212
  146. #define UMSERR_NoNetAccess       213
  147. #define UMSERR_BadPattern        214
  148. #define UMSERR_BadVarname        215
  149. #define UMSERR_FsFull            216
  150. #define UMSERR_NoMsgMem          217
  151. #define UMSERR_MissingIndex      218
  152.  
  153. #define UMSERR_ServerTerminated  300
  154. #define UMSERR_CantWrite         301
  155. #define UMSERR_CantRead          302
  156. #define UMSERR_WrongMsgPtr       303
  157. #define UMSERR_ServerNotFree     304
  158. #define UMSERR_IDCountProb       305
  159. #define UMSERR_NoLogin           306
  160. #define UMSERR_WrongServer       307
  161. #define UMSERR_NoMem             308
  162.  
  163. /* Tags */
  164. #define UMSTAG_String    0x2000
  165. #define UMSTAG_VarPar    0x4000
  166.  
  167. /* ReadUMSMsg() */
  168. #define UMSTAG_RMsgNum         (TAG_USER +                  1)
  169. #define UMSTAG_RHeaderLength   (TAG_USER + UMSTAG_VarPar +  2)
  170. #define UMSTAG_RTextLength     (TAG_USER + UMSTAG_VarPar +  3)
  171. #define UMSTAG_RMsgDate        (TAG_USER + UMSTAG_VarPar +  4)
  172. #define UMSTAG_RChainUp        (TAG_USER + UMSTAG_VarPar +  7)
  173. #define UMSTAG_RChainDn        (TAG_USER + UMSTAG_VarPar +  8)
  174. #define UMSTAG_RChainLt        (TAG_USER + UMSTAG_VarPar +  9)
  175. #define UMSTAG_RChainRt        (TAG_USER + UMSTAG_VarPar + 10)
  176. #define UMSTAG_RGlobalFlags    (TAG_USER + UMSTAG_VarPar + 11)
  177. #define UMSTAG_RUserFlags      (TAG_USER + UMSTAG_VarPar + 12)
  178. #define UMSTAG_RLoginFlags     (TAG_USER + UMSTAG_VarPar + 13)
  179. #define UMSTAG_RHardLink       (TAG_USER + UMSTAG_VarPar + 14)
  180. #define UMSTAG_RSoftLink       (TAG_USER + UMSTAG_VarPar + 15)
  181. #define UMSTAG_RDateStyle      (TAG_USER +                 64)
  182. #define UMSTAG_RIDStyle        (TAG_USER +                 68)
  183. #define UMSTAG_RNoUpdate       (TAG_USER +                 69)
  184. #define UMSTAG_ReadMsgField    (TAG_USER + UMSTAG_String + UMSTAG_VarPar + 256)
  185. #define UMSTAG_RMsgText        (UMSTAG_ReadMsgField + UMSCODE_MsgText)
  186. #define UMSTAG_RFromName       (UMSTAG_ReadMsgField + UMSCODE_FromName)
  187. #define UMSTAG_RFromAddr       (UMSTAG_ReadMsgField + UMSCODE_FromAddr)
  188. #define UMSTAG_RToName         (UMSTAG_ReadMsgField + UMSCODE_ToName)
  189. #define UMSTAG_RToAddr         (UMSTAG_ReadMsgField + UMSCODE_ToAddr)
  190. #define UMSTAG_RMsgID          (UMSTAG_ReadMsgField + UMSCODE_MsgID)
  191. #define UMSTAG_RCreationDate   (UMSTAG_ReadMsgField + UMSCODE_CreationDate)
  192. #define UMSTAG_RReceiveDate    (UMSTAG_ReadMsgField + UMSCODE_ReceiveDate)
  193. #define UMSTAG_RReferID        (UMSTAG_ReadMsgField + UMSCODE_ReferID)
  194. #define UMSTAG_RGroup          (UMSTAG_ReadMsgField + UMSCODE_Group)
  195. #define UMSTAG_RSubject        (UMSTAG_ReadMsgField + UMSCODE_Subject)
  196. #define UMSTAG_RAttributes     (UMSTAG_ReadMsgField + UMSCODE_Attributes)
  197. #define UMSTAG_RComments       (UMSTAG_ReadMsgField + UMSCODE_Comments)
  198. #define UMSTAG_ROrganization   (UMSTAG_ReadMsgField + UMSCODE_Organization)
  199. #define UMSTAG_RDistribution   (UMSTAG_ReadMsgField + UMSCODE_Distribution)
  200. #define UMSTAG_RFolder         (UMSTAG_ReadMsgField + UMSCODE_Folder)
  201. #define UMSTAG_RFidoID         (UMSTAG_ReadMsgField + UMSCODE_FidoID)
  202. #define UMSTAG_RMausID         (UMSTAG_ReadMsgField + UMSCODE_MausID)
  203. #define UMSTAG_RReplyGroup     (UMSTAG_ReadMsgField + UMSCODE_ReplyGroup)
  204. #define UMSTAG_RReplyName      (UMSTAG_ReadMsgField + UMSCODE_ReplyName)
  205. #define UMSTAG_RReplyAddr      (UMSTAG_ReadMsgField + UMSCODE_ReplyAddr)
  206. #define UMSTAG_RFidoText       (UMSTAG_ReadMsgField + UMSCODE_FidoText)
  207. #define UMSTAG_RErrorText      (UMSTAG_ReadMsgField + UMSCODE_ErrorText)
  208. #define UMSTAG_RNewsreader     (UMSTAG_ReadMsgField + UMSCODE_Newsreader)
  209. #define UMSTAG_RMsgInfo        (TAG_USER + 512)
  210. #define UMSTAG_RTextFields     (TAG_USER + 513)
  211. #define UMSTAG_RReadHeader     (TAG_USER + 514)
  212. #define UMSTAG_RReadAll        (TAG_USER + 515)
  213.  
  214. /* WriteUMSMsg() */
  215. #define UMSTAG_WMsgNum         (TAG_USER +  1)
  216. #define UMSTAG_WMsgDate        (TAG_USER +  4)
  217. #define UMSTAG_WChainUp        (TAG_USER +  7)
  218. #define UMSTAG_WHardLink       (TAG_USER + 14)
  219. #define UMSTAG_WSoftLink       (TAG_USER + 15)
  220. #define UMSTAG_WAutoBounce     (TAG_USER + 65)
  221. #define UMSTAG_WHdrFill        (TAG_USER + 66)
  222. #define UMSTAG_WTxtFill        (TAG_USER + 67)
  223. #define UMSTAG_WNoUpdate       (TAG_USER + 69)
  224. #define UMSTAG_WHide           (TAG_USER + 70)
  225. #define UMSTAG_WriteMsgField   (TAG_USER + UMSTAG_String + 256)
  226. #define UMSTAG_WMsgText        (UMSTAG_WriteMsgField + UMSCODE_MsgText)
  227. #define UMSTAG_WFromName       (UMSTAG_WriteMsgField + UMSCODE_FromName)
  228. #define UMSTAG_WFromAddr       (UMSTAG_WriteMsgField + UMSCODE_FromAddr)
  229. #define UMSTAG_WToName         (UMSTAG_WriteMsgField + UMSCODE_ToName)
  230. #define UMSTAG_WToAddr         (UMSTAG_WriteMsgField + UMSCODE_ToAddr)
  231. #define UMSTAG_WMsgID          (UMSTAG_WriteMsgField + UMSCODE_MsgID)
  232. #define UMSTAG_WCreationDate   (UMSTAG_WriteMsgField + UMSCODE_CreationDate)
  233. #define UMSTAG_WReceiveDate    (UMSTAG_WriteMsgField + UMSCODE_ReceiveDate)
  234. #define UMSTAG_WReferID        (UMSTAG_WriteMsgField + UMSCODE_ReferID)
  235. #define UMSTAG_WGroup          (UMSTAG_WriteMsgField + UMSCODE_Group)
  236. #define UMSTAG_WSubject        (UMSTAG_WriteMsgField + UMSCODE_Subject)
  237. #define UMSTAG_WAttributes     (UMSTAG_WriteMsgField + UMSCODE_Attributes)
  238. #define UMSTAG_WComments       (UMSTAG_WriteMsgField + UMSCODE_Comments)
  239. #define UMSTAG_WOrganization   (UMSTAG_WriteMsgField + UMSCODE_Organization)
  240. #define UMSTAG_WDistribution   (UMSTAG_WriteMsgField + UMSCODE_Distribution)
  241. #define UMSTAG_WFolder         (UMSTAG_WriteMsgField + UMSCODE_Folder)
  242. #define UMSTAG_WFidoID         (UMSTAG_WriteMsgField + UMSCODE_FidoID)
  243. #define UMSTAG_WMausID         (UMSTAG_WriteMsgField + UMSCODE_MausID)
  244. #define UMSTAG_WReplyGroup     (UMSTAG_WriteMsgField + UMSCODE_ReplyGroup)
  245. #define UMSTAG_WReplyName      (UMSTAG_WriteMsgField + UMSCODE_ReplyName)
  246. #define UMSTAG_WReplyAddr      (UMSTAG_WriteMsgField + UMSCODE_ReplyAddr)
  247. #define UMSTAG_WFidoText       (UMSTAG_WriteMsgField + UMSCODE_FidoText)
  248. #define UMSTAG_WErrorText      (UMSTAG_WriteMsgField + UMSCODE_ErrorText)
  249. #define UMSTAG_WNewsreader     (UMSTAG_WriteMsgField + UMSCODE_Newsreader)
  250. #define UMSTAG_WTextFields     (TAG_USER + 513)
  251.  
  252. /* UMSSelect() */
  253. #define UMSTAG_SelSet          (TAG_USER +                 1024)
  254. #define UMSTAG_SelUnset        (TAG_USER +                 1025)
  255. #define UMSTAG_SelWriteGlobal  (TAG_USER +                 1026)
  256. #define UMSTAG_SelWriteLocal   (TAG_USER +                 1027)
  257. #define UMSTAG_SelWriteUser    (TAG_USER + UMSTAG_String + 1028)
  258. #define UMSTAG_SelStart        (TAG_USER +                 1032)
  259. #define UMSTAG_SelStop         (TAG_USER +                 1033)
  260. #define UMSTAG_SelReadGlobal   (TAG_USER +                 1034)
  261. #define UMSTAG_SelReadLocal    (TAG_USER +                 1035)
  262. #define UMSTAG_SelReadUser     (TAG_USER + UMSTAG_String + 1036)
  263. #define UMSTAG_SelMask         (TAG_USER +                 1040)
  264. #define UMSTAG_SelMatch        (TAG_USER +                 1041)
  265. #define UMSTAG_SelParent       (TAG_USER +                 1042)
  266. #define UMSTAG_SelDate         (TAG_USER +                 1043)
  267. #define UMSTAG_SelTree         (TAG_USER +                 1044)
  268. #define UMSTAG_SelSubTree      (TAG_USER +                 1045)
  269. #define UMSTAG_SelMsg          (TAG_USER +                 1046)
  270. #define UMSTAG_SelQuick        (TAG_USER +                 1047)
  271.  
  272. /* UMSSearch() */
  273. #define UMSTAG_SearchLast      (TAG_USER +                 2048)
  274. #define UMSTAG_SearchQuick     (TAG_USER +                 2049)
  275. #define UMSTAG_SearchGlobal    (TAG_USER +                 2050)
  276. #define UMSTAG_SearchLocal     (TAG_USER +                 2051)
  277. #define UMSTAG_SearchUser      (TAG_USER + UMSTAG_String + 2052)
  278. #define UMSTAG_SearchDirection (TAG_USER +                 2053)
  279. #define UMSTAG_SearchPattern   (TAG_USER +                 2054)
  280. #define UMSTAG_SearchMask      (TAG_USER +                 2064)
  281. #define UMSTAG_SearchMatch     (TAG_USER +                 2065)
  282.  
  283. /* ReadUMSConfig(), WriteUMSConfig() */
  284. #define UMSTAG_CfgGlobalOnly   (TAG_USER +                 3072)
  285. #define UMSTAG_CfgName         (TAG_USER + UMSTAG_String + 3073)
  286. #define UMSTAG_CfgUser         (TAG_USER + UMSTAG_String + 3074)
  287.  
  288. /* ReadUMSConfig() */
  289. #define UMSTAG_CfgUserName     (TAG_USER + UMSTAG_String + 3075)
  290.  
  291. /* not yet implemented :
  292. #define UMSTAG_CfgMatchPattern (TAG_USER +                 3076)
  293. #define UMSTAG_CfgSameNetgroup (TAG_USER + UMSTAG_String + 3077)
  294. #define UMSTAG_CfgNextAka      (TAG_USER + UMSTAG_String + 3078)
  295. #define UMSTAG_CfgNextNetgroup (TAG_USER + UMSTAG_String + 3079)
  296. #define UMSTAG_CfgNextUser     (TAG_USER + UMSTAG_String + 3080)
  297. #define UMSTAG_CfgNextAlias    (TAG_USER + UMSTAG_String + 3081)
  298. #define UMSTAG_CfgNextString   (TAG_USER + UMSTAG_String + 3082)
  299. */
  300.  
  301. /* WriteUMSConfig() */
  302. #define UMSTAG_CfgDump         (TAG_USER + UMSTAG_String + 3088)
  303. #define UMSTAG_CfgData         (TAG_USER + UMSTAG_String + 3089)
  304.  
  305. #endif
  306.